home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / pcboard / bcmx120.zip / MX.DOC < prev    next >
Text File  |  1994-07-12  |  21KB  |  401 lines
  1.  
  2.         ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  3.          ────═════════φ  PCB 15.1+ Dos/Lightbar Matrix PPE  φ══════════────
  4.         ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  5.                    
  6.                              (C) BlackCat, FREEWARE
  7.                            Version 1.20
  8.  
  9.         ────────────────────────────────────────────────────────────────────
  10.  
  11.         Well here's yet another lightbar/dos ppe including infoform and
  12.         misc things. I decided to make this matrix ppe because one day
  13.         while I was looking at this other matrix ppe I was using I noticed
  14.         a strange sentence which implied that there was some kind of backdoor.
  15.         Since I'm not one to take chances I threw it away immediately and made
  16.         my own matrix. I also promise that there isn't any sneeky backdoor in
  17.         this matrix (well, not intentionally at least).
  18.  
  19.         You can consider this matrix freeware, although I will accept 
  20.         donations :-). The matrix is not crippled in any way.
  21.         If I don't get enough feedback to be able to improve or fix bugs in
  22.         this matrix I might add a message of some sort in later versions. 
  23.  
  24.     I've tested the matrix and PPEs in a desqview environment and tried
  25.     to code them in such a way as to prevent multinode access problems.
  26.     If you find any problem related to multinode access please let me know
  27.     as soon as possible as these problems are usually serious. 
  28.  
  29.  
  30.         ────────────────────────────────────────────────────────────────────
  31.              ──────────═════════φ  INSTALLATION  φ══════════────────────
  32.         ────────────────────────────────────────────────────────────────────
  33.  
  34.         Here are some quick installation guidelines:
  35.  
  36.                 ■ Extract the zipfile using the -d option to a directory. 
  37.           (If you're using some other extraction make sure that empty
  38.           directories are created)
  39.                 ■ Edit the configuration file MX.CFG and change the setup
  40.           information to suit your needs. If you don't plan on using
  41.           the included NUV ppe make sure that token 1 of line 14 is
  42.           set to NO so that the matrix does not try to display the 
  43.           voting status of my NUV.
  44.                 ■ Run 'MKPCBTXT <TEXTFILE>' goto line 259 using F3 and
  45.                   change this line to '!<PPEPATH>\MX.PPE', where <PPEPATH> is
  46.           the  directory where you unzipped the matrix.
  47.                   You also have to change line 260 to '_', this is to remove
  48.                   the last name question which is optional when using handles.
  49.         ■ You may optionally replace PCBTEXT #148 (Password prompt)
  50.           with 148.PPE using the same procedure as described above.
  51.           This displays a suitable message instead of the password
  52.           prompt. (Line displayed is line 10 of GRAPH\MXTEXT)
  53.         ■ If you want to use the NUV ppe included in this distribution 
  54.           add '!<PPEPATH>\NUV.PPE' to your logon script. The NUV ppe
  55.           recognizes users with new user security and adds them to the 
  56.           NUV. The security used is the one you have setup in 
  57.           pcboard.dat for new registered users (see NUV.CFG and furhter
  58.           for further information about the NUV)
  59.           If you do not want to use the NUV.PPE don't worry, the matrix
  60.           is fully functional without it, just make sure that NUV 
  61.           status displaying at the matrix is disabled (MX.CFG, line 14).
  62.                 ■ That's it, you're ready to go...
  63.  
  64.  
  65.         This ppe requires ANSI capability, so make sure everyone's using it.
  66.  
  67.     As of version 1.20 the matrix detects if ALIAS psa is installed and
  68.     asks it on application (only if setup in PWRD and pcboard.dat of
  69.     course). Also instead of skipping the default protocol selection
  70.     query it now handles this with a nice protocol selection lightbar
  71.     (DOPROT.PPE).
  72.  
  73.     You optionally may also want to change prompt 419 into something like
  74.         "@X08P@X07res@X0Fs (Enter) to continue_", this will make the matrix
  75.     look better IMHO (Or better yet use my Enter prompt replacement PPE :-).
  76.  
  77.  
  78.         ────────────────────────────────────────────────────────────────────
  79.              ──────────═════════φ  CONFIGURATION  φ══════════────────────
  80.         ────────────────────────────────────────────────────────────────────
  81.  
  82.         What follows is a global explanation of the matrix and components.
  83.     The aim in this is to let you have a global understanding of how all
  84.     the pieces fit together and provide some extra information where needed,
  85.     more detailed setup information should be available in the configuration
  86.     files (.CFG) themselves.
  87.  
  88.  
  89.     MX.PPE
  90.  
  91.     This is the main matrix PPE. Use MX.CFG to configure global options.
  92.     The following configuration files can be used to configure
  93.     (parts) of the matrix. 
  94.  
  95.            LIGHTBAR.CFG    - Used to configure the lighbar menu part of
  96.                              the matrix.
  97.  
  98.            DOS.CFG         - Used to configure the dos matrix part of the
  99.                              ppe. The prompt text resides in GRAPH\MXTEXT. 
  100.  
  101.            CFG\LOGON.CFG   - Configures the logon prompt files.
  102.            CFG\APPLY.CFG   - Configures the normal (ie standard question) 
  103.                              matrix application files.
  104.            CFG\ADDRESS.CFG - Configures the address PSA matrix application
  105.                              files.
  106.            CFG\MAIDEN.CFG  - Configures the verification PSA matrix
  107.                              application files.
  108.            CFG\CHECK.CFG   - Configures the check access prompt files.
  109.            CFG\MXAPPLY.CFG - Configures the matrix application prompt files.
  110.            CFG\PROT.CFG    - Configures the protocol selection menu. Used
  111.                              by DOPROT.PPE.
  112.            CFG\ALIAS.CFG   - Configures the alias selection when applying.
  113.                              Alias selection when applying is only used
  114.                  if alias is setup (PSA and PWRD) and should
  115.                  be asked (Configuration options in PCBSETUP)
  116.  
  117.  
  118.         I've had some comments about the large number of tokens in some lines
  119.     in the .CFG. I've tried putting every single option on a different
  120.     line when I started coding the matrix. But as I kept on adding options
  121.     I noticed that this started to delay the matrix and others PPEs too
  122.     much for my liking, so I started adding options as tokens wherever
  123.     possible. Every option as an token prevents an extra line read and
  124.     considering the large number of configurable options in some parts
  125.     (eg. see NUV.CFG ;) this can cause quite a delay.
  126.  
  127.     FEEDBACK.PPE
  128.  
  129.         The sysop feedback is handled by this ppe. Use FEEDBACK.CFG to 
  130.     configure it and CFG\FBMENUS.CFG to configure the menus. MNUTXT\FBMNU
  131.         holds the default feedback menu text. To create a different look for 
  132.     each (randomly chosen) feedback menu you can create extra MNUTXT\FBMNU#
  133.     files (where # is the menu number) which overrides the default feedback
  134.         menu text. 
  135.     If you only have one sysop defined the sysop selection menu will
  136.     not be displayed.
  137.  
  138.  
  139.         INFOFORM.PPE
  140.  
  141.         The infoforms are handled by this ppe. Use INFOFORM.CFG to configure
  142.     it and CFG\FRMMENUS.CFG to configure the menus. MNUTXT\FRMMNU holds
  143.     the default infoform menu text. To create a different look for each
  144.     (randomly chosed) infoform menu you can create extra MNUTXT\FRMMNU# 
  145.     files (where # is the menu number) which overrides the default 
  146.     infoform menu text.
  147.         The subdirectory FORM contains all the infoform specific files,
  148.     have a look at the .CFG files in there to see how the infoforms
  149.     are configured.
  150.     If a user is not logged on the infoform checks if a file 
  151.     'work\infotmp.<nodenr>' exist and if so uses the first line as the
  152.     users name. This is used by the matrix. 
  153.     The filled out infoform are stored in the APPS subdirectory.
  154.         The form output names are of the form '<USER NAME>.<FORM NUMBER>'.
  155.  
  156.         As of version 1.2 an ANSI stye is used by the infoforms to allow you to
  157.     create infoforms more easily. You simply create your ANSI (has to
  158.     be ansi, NO @ codes) infoform initially any way you want (animation mode
  159.     allowed too) and do NOT put any '*' characters in the ansi. After 
  160.     creating your entire picture save it, enter animation mode (in thedraw 
  161.     you can select it from the pulldown menu) and start putting the '*' at
  162.     the places where you want the questions to be asked. The order in which
  163.     you place the '*'s is the order in which the questions will be asked. 
  164.     The first nonwhite character found to the right of the '*' is the end of
  165.     the input field. If there's another character behind the '*' that 
  166.     character is considered white space too (you can also define some other
  167.     characters to walk over, see infoform.cfg).
  168.  
  169.  
  170.         NUV.PPE
  171.  
  172.     The new user voting is handled by this PPE. Use NUV.CFG to configure
  173.     this ppe and CFG\NUVMENUS.CFG to configure the menus. Each menu
  174.     defined in CFG\NUVMENUS.CFG has a file MNUTXT\NUVMNU# (where # is
  175.     the menu number) associated with it which defines the text used
  176.     in the menu. This way you can create a different look for each
  177.     nuv menu.
  178.     Several files in the APPS dir are created and used by the NUV ppe.
  179.     '<USERNAME>.VOT' contains the voting status for each user, please do 
  180.     not tamper with these files manually. If you do so voting for that
  181.     user might go wrong. 'WAITING.NUV' contains the current users who are
  182.     waiting for verification 'WAITING.CNT' contains the number of these
  183.         users). Normally these files need no manual intervention, the nuv ppe
  184.     creates and updates them. For the operation of this ppe have a look at
  185.     NUV.CFG.
  186.         If for some reason you need to remove a user from the nuv list before 
  187.     he has been voted in/out remove his name from 'WAITING.NUV' and
  188.     decrease the number in 'WAITING.CNT' by one.
  189.     As of version 1.10 of the matrix the NUV ppe has been recoded. The
  190.     voting now uses a lightbar menu and there is a sysop voting option
  191.     available which allows the sysop to vote someone in/out directly.
  192.     NUV also reads the matrix APPLY.VIP is available, and if new users
  193.     are found in there their security is automatically upgraded and
  194.     they're not inserted in the NUV process.
  195.  
  196.     When a new user being voted on logs on again and reaches the NUV
  197.     ppe he's shown the voting status. The file displayed is GRAPH\VOTSTAT.
  198.     This voting status can also be displayed by the matrix (Line 14 of 
  199.     MX.CFG). There are a couple of replacement codes allowed in this file:
  200.  
  201.               %NO%    - No votes so far.
  202.               %YES%   - Yes votes so far.
  203.               %NON%   - Total no votes needed for removal/deletion
  204.               %YESN%  - Total yes votes needed for validation
  205.  
  206.  
  207.     NONUV.PPE
  208.  
  209.     This ppe can be used by sysops who don't want to use NUV on their
  210.     board. All this PPE does is display GRAPH\NONUV to the user and 
  211.     disconnect the user. This should contain a message that the sysop will
  212.     review his application and he should call back etc. Put this in your
  213.     logon script (preferrably a new user specific logon script so it won't 
  214.     be run for every user each time and thus unnecessarily delay logon).
  215.  
  216.  
  217.         DOPROT.PPE
  218.     
  219.     This little PPE handles the protocol selection for applying users.
  220.     It is only used if protocol selection is setup in PCBSETUP. Use
  221.     CFG\PROT.CFG to configure this.
  222.  
  223.  
  224.         PAGE.PPE
  225.  
  226.         This ppe handles the sysop paging. Use PAGE.CFG to configure this ppe
  227.     and CFG\PGMENUS.CFG to configure the prompts.
  228.     The paging ppe checks the paging times in pcboard.dat. It also does
  229.     not page if the page bell if off. For this purpose it needs the file
  230.     pcboard.sys which is assumed to be in the directory where pcboard.dat
  231.     resides (for each node). Through 'PAGE.CFG' you can adjust the page
  232.     duration. If not logged on (matrix) the users name is asked and logged.
  233.  
  234.     The feedback and infoform PPEs are fully functional as seperate
  235.     ppe's and can be used as doors if you want. 
  236.  
  237.         The subdir GRAPH contains the display files used by the matrix and
  238.     other ppe's. These files are hardcoded into the ppe's so if you move
  239.     a ppe to another directory make sure to copy the necessary graph
  240.     files to a subdirectory 'graph' where the ppe resides. For the external
  241.     PPEs (infoform/feedback/nuv/page) it is only necessary to move some 
  242.     files which are used, which these are should be selfexplanatory.
  243.  
  244.         Here's a list of files in 'graph' that you can change to your liking, 
  245.     where appropriate I also mention which configuration file you can use
  246.     to configure the menus/promptfiles: 
  247.  
  248.         APPLY#   : Menus displayed when entering standard pcboard new user
  249.                    registration information. To configure this use 
  250.            CFG\APPLY.CFG
  251.         ADDR#    : Menus displayed when entering non standard PSA (pcboard
  252.                    supported allocations) address information. If address psa is
  253.                    not installed this menu is not used. (note that verification
  254.                    psa is also detected when a user apply's). To configure this
  255.            use CFG\ADDRESS.CFG
  256.     ALIAS#   : Prompt file when entering an applicationa alias. To configure
  257.                use CFG\ALIAS.CFG.
  258.     PROT#    : Protocol ppe (DOPROT.PPE) display files. Used when asking
  259.                a default protocol at application.
  260.         MXTEXT   : Contains most of the matrix prompts and display lines,
  261.                    change them to suit your needs.
  262.         MXHLP    : Matrix Lightbar menu helpfile (when pressing '?').
  263.         WEL#     : Welcome files displayed after a successull logon. To 
  264.                configure use MX.CFG.
  265.     OFF#     : Logoff files displayed when the user selects logoff at the
  266.                matrix. To configure use MX.CFG. 
  267.         MXS#     : The main lightbar menu display files. The 'lightbar.cfg'
  268.                    file can be used to configure the coordinates of where
  269.                    to display the lightbar menu in these files.
  270.         DISC     : Disclaimer file shown (optionally) at the NUA. You can 
  271.            also use this file to welcome the user and/or show him
  272.            some guidelines on how to fill out all the newuser info.
  273.     DOSHLP   : Help file displayed when help is typed at the dos matrix.
  274.     DIR/DIRW : Dos matrix directory file displayed when dir is typed. The
  275.            'dos.cfg' file can be used to define all dos command. If you
  276.            do so don't forget to change this 'dir' file accordingly.
  277.     FEED#    : Sysop feedback menus. To congifure use CFG\FBMENUS.CFG.
  278.     FBINFO#  : Sysop feedback information menu. (To, From, Subject). To
  279.                configure use CFG\FBMENUS.CFG
  280.     FBHDR#   : Sysop feedback header files, shown when a user enters
  281.                feedback. To configure use CFG\FBMENUS.CFG.
  282.     FBMSG     : File displayed before a user enters application feedback at
  283.                the matrix.
  284.     FBTXT    : Contains the feedback ppe prompts and display lines.
  285.     FBHLP    : Feedback menu helpfile.
  286.     FORM#    : Infoform menus. To configure use CFG\FRMMENUS.CFG.
  287.     FRMTEXT  : Contains the infoform ppe prompts and display lines.
  288.     FRMHLP   : Infoform menu helpfile.
  289.     PGTEXT   : Contains the page ppe prompts and display lines.
  290.     PAGE#    : The page prompt files. (From, Page reason). To configure
  291.                use CFG\PGMENUS.CFG.
  292.     PGNO#    : The 'sysop not availabe for page' display files. To configure
  293.                use CFG\PGMENUS.CFG.
  294.     EMER#    : Display file shown when a user is asked for an emergency
  295.                password when paging the sysop. Only used if the emergency
  296.            password is setup in PAGE.CFG
  297.     PGSYS    : File displayed to the sysop when he's being paged. Use
  298.                only ANSI in this one as pcboard codes don't seem to get
  299.            through.
  300.         LOGON#   : Logon prompt files. (System password, user name, user 
  301.                password). To configure use CFG\LOGON.CFG
  302.         MXAPP#   : Matrix application prompt files. To configure use
  303.                CFG\MXAPPLY.CFG
  304.     FEED#    : Feedback prompt files. To configure use CFG\FBMENUS.CFG.
  305.     CHECK#   : Access check prompt files. To configure use CFG\CHECK.CFG.
  306.     NUV#     : New user voting main menu files. To configure use 
  307.                CFG\NUVMENUS.CFG.
  308.     VOTE#    : New user voting menus. To configure use CFG\NUVMENUS.CFG.
  309.         NUVDISC  : File displayed when a new user is disconnected by the nuv
  310.                PPE.
  311.     NUVVOT   : File displayed when asking users if they want to vote now.
  312.     NUVHLP   : New user voting menu helpfile.
  313.     NUVSTAT  : Voting status displayed to users who are still being voted 
  314.                on by the NUV. 
  315.            
  316.         NUVOUT   : File displayed by the nuv (or matrix if nuv status display
  317.                is setup in line 14 of MX.CFG) when is user is voted out.
  318.         NUVVIP   : File displayed by the NUV.PPE if a new user is found in the
  319.                APPLY.VIP file. The security is immediately upgraded and the
  320.            user has access to the board, be carefull with this option.
  321.     NONUV    : File displayed by the NONUV.PPE.
  322.  
  323.         Files not explicitly mentioned:
  324.  
  325.     SYS*     : Files used by the SYSOP.PPE
  326.     *TEXT    : Various other text files. Their naming should make it obvious
  327.                for which PPE/part they contain the text.
  328.  
  329.  
  330.         The directory MNUTXT contains all the text used in the various 
  331.     lightbar menus. These can be:
  332.  
  333.         NUVMNU# : NUV lightbar menu text for each (randomly displayed)
  334.               menu defined through CFG\NUVMENUS.CFG.
  335.     FBMNU,
  336.         FBMNU#  : Feedback lightbar menu text. FBMNU contains the default
  337.               text. For each lighbar menu you can create FBMNU# (where
  338.           # is the menu number) which will override the default FBMNU.
  339.           The reason for this default text file is that adding and/or
  340.           deleting sysops would mean updating all the FBMNU# files and
  341.           I realize that some of you may find that annoying or too much
  342.           trouble. By creating FBMNU# files you can have a totally
  343.           different look for each random menu.
  344.     FRMMNU
  345.     FRMMNU# : Infoform lightbar menu text. FRMMNU contains the default text.
  346.               For each lighbar menu you can create FRMMNU# (where
  347.           # is the menu number) which will override the default FRMMNU.
  348.           The reason for this default text file is that adding and/or
  349.           deleting infoforms would mean updating all the FRMMNU# files
  350.           and I realize that some of you may find that annoying or too
  351.           much trouble. By creating FBMNU# files you can have a totally
  352.           different look for each random menu.
  353.     MXMNU   : Default matrix lighbar menu text. Note that this is only used
  354.               if the text is not taken directly from the display file (see
  355.           LIGHTBAR.CFG). Again as above you can create MXMNU# files to
  356.           have different text for each menu.
  357.               
  358.  
  359.     Use the UNWANTED file in the matrix dir to exclude certain user
  360.     names from applying. Just add unwanted names to this file.
  361.  
  362.     The APPLY.VIP holds names of users who should be exempt from 
  363.     entering the NUP when applying (also used by the NUV ppe).
  364.  
  365.         The subdir WORK contains temporary files and the matrix logs (if
  366.         logs are enabled)
  367.  
  368.         The subdir APPS contains the filled out application forms for the
  369.         users who applied and the nuv information files. The infoform names
  370.         are of the form '<user name>.<form number>'.
  371.     
  372.     The ppe 'SYSOP.PPE' can be used to view/remove the logs and change/view
  373.     some configuration options.
  374.  
  375.     The EXTERNAL.CFG file can be used to define as many external commands
  376.     as you want.
  377.  
  378.  
  379.         ────────────────────────────────────────────────────────────────────
  380.                ──────────═════════φ  AUTHOR  φ══════════────────────
  381.         ────────────────────────────────────────────────────────────────────
  382.  
  383.     For fast response mail me on internet (an42144@anon.penet.fi). 
  384.     You can also contact me at The Godfather, MaFIA WHQ by mailing 
  385.     'El GaTO'.
  386.  
  387.     I've been having problems with the anon server. Not only has it gotten 
  388.     too slow but it also doesn't allow reasonably big files (>40K) to be 
  389.     mailed through it. So if you want me to send you the newest version of 
  390.     this or any other of my PPEs send me your non anonymous address, and I
  391.     will forward you the files. Alternatively you can also get the newest
  392.     versions at wuarchive.wustl.edu in directory /pub/MSDOS_UPLOADS/ppe.
  393.     If anyone knows of any better (internet) places to put these I'm open
  394.     to suggestions.
  395.  
  396.         If you find any bugs or have any suggestions/comments don't hesitate
  397.     to contact me. 
  398.  
  399.     Enjoy,
  400.     BlackCat
  401.